analytics_dashboard_home_overview

Home > Overview revenue-quality card (new vs returning, subs vs one-time, AOV)

Returns the “Revenue quality” card that sits in “The month’s economics” section on Home > Overview. Splits the current month’s paid revenue three ways: new vs returning (per-order cohort), subscription vs one-time (presence of subscription_id), and three AOV values (blended, new-customer, returning-customer).

Spec decision D-4 pinned the cohort definition to a per-order classification — a customer’s first-ever paid order is new and every subsequent order is returning. Buyer identity is orders.member_id (populated on every paid order — the checkout flow mints a member row on first purchase; the unique members(company_id, email) index keeps that identity stable across returning purchases).

GET

api

v202604

analytics

dashboard

revenue_quality

Home > Overview revenue-quality card (new vs returning, subs vs one-time, AOV)

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "new_vs_returning": {
    "new": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    },
    "returning": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    }
  },
  "subs_vs_one_time": {
    "subscription": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    },
    "one_time": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    }
  },
  "aov": {
    "blended": "180.25",
    "new_customer": "180.25",
    "returning_customer": "180.25"
  },
  "currency": "USD",
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Requires a company-admin token whose role holds reports.view. Additionally, the caller's company must have ANALYTICS_DASHBOARD enabled — otherwise every endpoint returns 404.

Query Parameters

country

string

ISO alpha-2 code of one of the requesting company's configured countries (see GET /countries). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send "all") for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return 400.

Example:

"US"

Response

Revenue-quality card payload

new_vs_returning

object

required

Keyed by cohort. new is any paid order whose buyer has no prior paid order in this company; returning is any paid order whose buyer already has one — per-order classification (spec decision D-4).

Show child attributes

subs_vs_one_time

object

required

Keyed by subscription mode. An order is subscription when its subscription_id is populated (both initial checkouts and renewals); everything else is one_time.

Show child attributes

aov

object

required

Average order value for the current month. blended covers all paid orders; new_customer and returning_customer split the same set by cohort. Values are Money strings; empty cohorts return "0.0" rather than divide-by-zero.

Show child attributes

currency

string

required

ISO 4217 three-letter code (uppercase).

Required string length: 3

Example:

"USD"

meta

object

Show child attributes

Home > Overview revenue-quality card (new vs returning, subs vs one-time, AOV)

curl --request GET \
  --url https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/analytics/dashboard/revenue_quality")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "new_vs_returning": {
    "new": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    },
    "returning": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    }
  },
  "subs_vs_one_time": {
    "subscription": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    },
    "one_time": {
      "revenue": "180.25",
      "orders_count": 1,
      "revenue_pct": "42.5"
    }
  },
  "aov": {
    "blended": "180.25",
    "new_customer": "180.25",
    "returning_customer": "180.25"
  },
  "currency": "USD",
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "error": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "request_id": "<string>"
  }
}

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

Home > Overview revenue-quality card (new vs returning, subs vs one-time, AOV)

Authorizations

Query Parameters

Response